<?xml version="1.0"?>
<doc>
    <assembly>
        <name>HistorianAdapters</name>
    </assembly>
    <members>
        <member name="T:HistorianAdapters.LocalInputAdapter">
            <summary>
            Represents an output adapter that publishes measurements to openHistorian for archival.
            </summary>
        </member>
        <member name="M:HistorianAdapters.LocalInputAdapter.#ctor">
            <summary>
            Creates a new instance of the <see cref="T:HistorianAdapters.LocalInputAdapter"/>.
            </summary>
        </member>
        <member name="M:HistorianAdapters.LocalInputAdapter.Dispose(System.Boolean)">
            <summary>
            Releases the unmanaged resources used by the <see cref="T:HistorianAdapters.LocalInputAdapter"/> object and optionally releases the managed resources.
            </summary>
            <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
        </member>
        <member name="M:HistorianAdapters.LocalInputAdapter.Initialize">
            <summary>
            Initializes this <see cref="T:HistorianAdapters.LocalInputAdapter"/>.
            </summary>
            <exception cref="T:System.ArgumentException"><b>HistorianID</b>, <b>Server</b>, <b>Port</b>, <b>Protocol</b>, or <b>InitiateConnection</b> is missing from the <see cref="P:GSF.TimeSeries.Adapters.AdapterBase.Settings"/>.</exception>
        </member>
        <member name="M:HistorianAdapters.LocalInputAdapter.GetShortStatus(System.Int32)">
            <summary>
            Gets a short one-line status of this <see cref="T:HistorianAdapters.LocalInputAdapter"/>.
            </summary>
            <param name="maxLength">Maximum length of the status message.</param>
            <returns>Text of the status message.</returns>
        </member>
        <member name="M:HistorianAdapters.LocalInputAdapter.AttemptConnection">
            <summary>
            Attempts to connect to this <see cref="T:HistorianAdapters.LocalInputAdapter"/>.
            </summary>
        </member>
        <member name="M:HistorianAdapters.LocalInputAdapter.AttemptDisconnection">
            <summary>
            Attempts to disconnect from this <see cref="T:HistorianAdapters.LocalInputAdapter"/>.
            </summary>
        </member>
        <member name="P:HistorianAdapters.LocalInputAdapter.InstanceName">
            <summary>
            Gets or sets instance name defined for this <see cref="T:HistorianAdapters.LocalInputAdapter"/>.
            </summary>
        </member>
        <member name="P:HistorianAdapters.LocalInputAdapter.ArchiveLocation">
            <summary>
            Gets or sets archive path for this <see cref="T:HistorianAdapters.LocalInputAdapter"/>.
            </summary>
        </member>
        <member name="P:HistorianAdapters.LocalInputAdapter.ArchiveOffloadLocation">
            <summary>
            Gets or sets archive offload path for this <see cref="T:HistorianAdapters.LocalInputAdapter"/>.
            </summary>
        </member>
        <member name="P:HistorianAdapters.LocalInputAdapter.PublicationInterval">
            <summary>
            Gets or sets the publication interval for this <see cref="T:HistorianAdapters.LocalInputAdapter"/>.
            </summary>
        </member>
        <member name="P:HistorianAdapters.LocalInputAdapter.StartTimeConstraint">
            <summary>
            Gets the start time for reading data.
            </summary>
        </member>
        <member name="P:HistorianAdapters.LocalInputAdapter.StopTimeConstraint">
            <summary>
            Gets the stop time for reading data.
            </summary>
        </member>
        <member name="P:HistorianAdapters.LocalInputAdapter.SimulateTimestamp">
            <summary>
            Gets or sets a value that determines whether timestamps are
            simulated for the purposes of real-time concentration.
            </summary>
        </member>
        <member name="P:HistorianAdapters.LocalInputAdapter.AutoRepeat">
            <summary>
            Gets or sets value that determines if the input data should be replayed repeatedly.
            </summary>
        </member>
        <member name="P:HistorianAdapters.LocalInputAdapter.SupportsTemporalProcessing">
            <summary>
            Gets the flag indicating if this adapter supports temporal processing.
            </summary>
        </member>
        <member name="P:HistorianAdapters.LocalInputAdapter.ProcessingInterval">
            <summary>
            Gets or sets the desired processing interval, in milliseconds, for the adapter.
            </summary>
            <remarks>
            With the exception of the values of -1 and 0, this value specifies the desired processing interval for data, i.e.,
            basically a delay, or timer interval, over which to process data. A value of -1 means to use the default processing
            interval while a value of 0 means to process data as fast as possible.
            </remarks>
        </member>
        <member name="P:HistorianAdapters.LocalInputAdapter.UseAsyncConnect">
            <summary>
            Gets flag that determines if this <see cref="T:HistorianAdapters.LocalInputAdapter"/> uses an asynchronous connection.
            </summary>
        </member>
        <member name="P:HistorianAdapters.LocalInputAdapter.Status">
            <summary>
            Returns the detailed status of the data input source.
            </summary>
        </member>
        <member name="T:HistorianAdapters.RemoteInputAdapter">
            <summary>
            Represents an input adapters that listens for time-series data from a remote Historian.
            </summary>
        </member>
        <member name="M:HistorianAdapters.RemoteInputAdapter.#ctor">
            <summary>
            Initializes a new instance of the <see cref="T:HistorianAdapters.RemoteInputAdapter"/> class.
            </summary>
        </member>
        <member name="M:HistorianAdapters.RemoteInputAdapter.Initialize">
            <summary>
            Initializes this <see cref="T:HistorianAdapters.RemoteInputAdapter"/>.
            </summary>
            <exception cref="T:System.ArgumentException"><b>HistorianID</b>, <b>Server</b>, <b>Port</b>, <b>Protocol</b>, or <b>InitiateConnection</b> is missing from the <see cref="P:GSF.TimeSeries.Adapters.AdapterBase.Settings"/>.</exception>
        </member>
        <member name="M:HistorianAdapters.RemoteInputAdapter.GetShortStatus(System.Int32)">
            <summary>
            Gets a short one-line status of this <see cref="T:HistorianAdapters.RemoteInputAdapter"/>.
            </summary>
            <param name="maxLength">Maximum length of the status message.</param>
            <returns>Text of the status message.</returns>
        </member>
        <member name="M:HistorianAdapters.RemoteInputAdapter.Dispose(System.Boolean)">
            <summary>
            Releases the unmanaged resources used by this <see cref="T:HistorianAdapters.RemoteInputAdapter"/> and optionally releases the managed resources.
            </summary>
            <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
        </member>
        <member name="M:HistorianAdapters.RemoteInputAdapter.AttemptConnection">
            <summary>
            Attempts to connect to this <see cref="T:HistorianAdapters.RemoteInputAdapter"/>.
            </summary>
        </member>
        <member name="M:HistorianAdapters.RemoteInputAdapter.AttemptDisconnection">
            <summary>
            Attempts to disconnect from this <see cref="T:HistorianAdapters.RemoteInputAdapter"/>.
            </summary>
        </member>
        <member name="P:HistorianAdapters.RemoteInputAdapter.Server">
            <summary>
            Gets or sets the host name or IP address of the openHistorian.
            </summary>
        </member>
        <member name="P:HistorianAdapters.RemoteInputAdapter.Port">
            <summary>
            Gets or sets the port on which the openHistorian is broadcasting data.
            </summary>
        </member>
        <member name="P:HistorianAdapters.RemoteInputAdapter.Protocol">
            <summary>
            Gets or sets the type of connection used to connect to the openHistorian.
            </summary>
        </member>
        <member name="P:HistorianAdapters.RemoteInputAdapter.InitiateConnection">
            <summary>
            Gets or sets a value that indicates whether the listener will initiate the connection to the openHistorian.
            </summary>
        </member>
        <member name="P:HistorianAdapters.RemoteInputAdapter.Status">
            <summary>
            Returns the detailed status of the data input source.
            </summary>
        </member>
        <member name="P:HistorianAdapters.RemoteInputAdapter.UseAsyncConnect">
            <summary>
            Gets flag that determines if this <see cref="T:HistorianAdapters.RemoteInputAdapter"/> uses an asynchronous connection.
            </summary>
        </member>
        <member name="P:HistorianAdapters.RemoteInputAdapter.SupportsTemporalProcessing">
            <summary>
            Gets the flag indicating if this adapter supports temporal processing.
            </summary>
        </member>
        <member name="T:HistorianAdapters.LocalOutputAdapter">
            <summary>
            Represents an output adapter that archives measurements to a local archive.
            </summary>
        </member>
        <member name="M:HistorianAdapters.LocalOutputAdapter.#ctor">
            <summary>
            Initializes a new instance of the <see cref="T:HistorianAdapters.LocalOutputAdapter"/> class.
            </summary>
        </member>
        <member name="M:HistorianAdapters.LocalOutputAdapter.ExecuteMetadataRefresh">
            <summary>
            Refreshes metadata using all available and enabled providers.
            </summary>
        </member>
        <member name="M:HistorianAdapters.LocalOutputAdapter.Initialize">
            <summary>
            Initializes this <see cref="T:HistorianAdapters.LocalOutputAdapter"/>.
            </summary>
            <exception cref="T:System.ArgumentException"><b>InstanceName</b> is missing from the <see cref="P:GSF.TimeSeries.Adapters.AdapterBase.Settings"/>.</exception>
        </member>
        <member name="M:HistorianAdapters.LocalOutputAdapter.GetShortStatus(System.Int32)">
            <summary>
            Gets a short one-line status of this <see cref="T:HistorianAdapters.LocalOutputAdapter"/>.
            </summary>
            <param name="maxLength">Maximum length of the status message.</param>
            <returns>Text of the status message.</returns>
        </member>
        <member name="M:HistorianAdapters.LocalOutputAdapter.Dispose(System.Boolean)">
            <summary>
            Releases the unmanaged resources used by this <see cref="T:HistorianAdapters.LocalOutputAdapter"/> and optionally releases the managed resources.
            </summary>
            <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
        </member>
        <member name="M:HistorianAdapters.LocalOutputAdapter.OnConnected">
            <summary>
            Called when data output source connection is established.
            </summary>
        </member>
        <member name="M:HistorianAdapters.LocalOutputAdapter.AttemptConnection">
            <summary>
            Attempts to connect to this <see cref="T:HistorianAdapters.LocalOutputAdapter"/>.
            </summary>
        </member>
        <member name="M:HistorianAdapters.LocalOutputAdapter.AttemptDisconnection">
            <summary>
            Attempts to disconnect from this <see cref="T:HistorianAdapters.LocalOutputAdapter"/>.
            </summary>
        </member>
        <member name="M:HistorianAdapters.LocalOutputAdapter.ProcessMeasurements(GSF.TimeSeries.IMeasurement[])">
            <summary>
            Archives <paramref name="measurements"/> locally.
            </summary>
            <param name="measurements">Measurements to be archived.</param>
            <exception cref="T:System.InvalidOperationException">Local archive is closed.</exception>
        </member>
        <member name="P:HistorianAdapters.LocalOutputAdapter.InstanceName">
            <summary>
            Gets or sets instance name defined for this <see cref="T:HistorianAdapters.LocalOutputAdapter"/>.
            </summary>
        </member>
        <member name="P:HistorianAdapters.LocalOutputAdapter.AutoRefreshMetadata">
            <summary>
            Gets or sets a boolean indicating whether or not metadata is
            refreshed when the adapter attempts to connect to the archive.
            </summary>
        </member>
        <member name="P:HistorianAdapters.LocalOutputAdapter.InputMeasurementKeys">
            <summary>
            Gets or sets primary keys of input measurements the <see cref="T:GSF.TimeSeries.Adapters.AdapterBase"/> expects, if any.
            </summary>
        </member>
        <member name="P:HistorianAdapters.LocalOutputAdapter.ArchivePath">
            <summary>
            Gets or sets the path to the archive.
            </summary>
        </member>
        <member name="P:HistorianAdapters.LocalOutputAdapter.OutputIsForArchive">
            <summary>
            Returns a flag that determines if measurements sent to this <see cref="T:HistorianAdapters.LocalOutputAdapter"/> are destined for archival.
            </summary>
        </member>
        <member name="P:HistorianAdapters.LocalOutputAdapter.UseAsyncConnect">
            <summary>
            Gets flag that determines if this <see cref="T:HistorianAdapters.LocalOutputAdapter"/> uses an asynchronous connection.
            </summary>
        </member>
        <member name="P:HistorianAdapters.LocalOutputAdapter.Status">
            <summary>
            Returns the detailed status of the data output source.
            </summary>
        </member>
        <member name="T:HistorianAdapters.RemoteOutputAdapter">
            <summary>
            Represents an output adapter that publishes measurements to openHistorian for archival.
            </summary>
        </member>
        <member name="M:HistorianAdapters.RemoteOutputAdapter.#ctor">
            <summary>
            Initializes a new instance of the <see cref="T:HistorianAdapters.RemoteOutputAdapter"/> class.
            </summary>
        </member>
        <member name="M:HistorianAdapters.RemoteOutputAdapter.Initialize">
            <summary>
            Initializes this <see cref="T:HistorianAdapters.RemoteOutputAdapter"/>.
            </summary>
            <exception cref="T:System.ArgumentException"><b>Server</b> is missing from the <see cref="P:GSF.TimeSeries.Adapters.AdapterBase.Settings"/>.</exception>
        </member>
        <member name="M:HistorianAdapters.RemoteOutputAdapter.GetShortStatus(System.Int32)">
            <summary>
            Gets a short one-line status of this <see cref="T:HistorianAdapters.RemoteOutputAdapter"/>.
            </summary>
            <param name="maxLength">Maximum length of the status message.</param>
            <returns>Text of the status message.</returns>
        </member>
        <member name="M:HistorianAdapters.RemoteOutputAdapter.Dispose(System.Boolean)">
            <summary>
            Releases the unmanaged resources used by this <see cref="T:HistorianAdapters.RemoteOutputAdapter"/> and optionally releases the managed resources.
            </summary>
            <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
        </member>
        <member name="M:HistorianAdapters.RemoteOutputAdapter.AttemptConnection">
            <summary>
            Attempts to connect to this <see cref="T:HistorianAdapters.RemoteOutputAdapter"/>.
            </summary>
        </member>
        <member name="M:HistorianAdapters.RemoteOutputAdapter.AttemptDisconnection">
            <summary>
            Attempts to disconnect from this <see cref="T:HistorianAdapters.RemoteOutputAdapter"/>.
            </summary>
        </member>
        <member name="M:HistorianAdapters.RemoteOutputAdapter.ProcessMeasurements(GSF.TimeSeries.IMeasurement[])">
            <summary>
            Publishes <paramref name="measurements"/> for archival.
            </summary>
            <param name="measurements">Measurements to be archived.</param>
            <exception cref="T:System.OperationCanceledException">Acknowledgement is not received from historian for published data.</exception>
        </member>
        <member name="P:HistorianAdapters.RemoteOutputAdapter.Server">
            <summary>
            Gets or sets the host name for the server hosting the remote historian.
            </summary>
        </member>
        <member name="P:HistorianAdapters.RemoteOutputAdapter.Port">
            <summary>
            Gets or sets the port on which the remote historian is listening.
            </summary>
        </member>
        <member name="P:HistorianAdapters.RemoteOutputAdapter.PayloadAware">
            <summary>
            Gets or sets a boolean value indicating whether the payload
            boundaries are to be preserved during transmission.
            </summary>
        </member>
        <member name="P:HistorianAdapters.RemoteOutputAdapter.ConserveBandwidth">
            <summary>
            Gets or sets a boolean value that determines the packet
            type to be used when sending data to the server.
            </summary>
        </member>
        <member name="P:HistorianAdapters.RemoteOutputAdapter.OutputIsForArchive">
            <summary>
            Returns a flag that determines if measurements sent to this <see cref="T:HistorianAdapters.RemoteOutputAdapter"/> are destined for archival.
            </summary>
        </member>
        <member name="P:HistorianAdapters.RemoteOutputAdapter.ThrottleTransmission">
            <summary>
            Gets or sets a boolean value that determines whether to wait for
            acknowledgement from the historian that the last set of points have
            been received before attempting to send the next set of points.
            </summary>
        </member>
        <member name="P:HistorianAdapters.RemoteOutputAdapter.SamplesPerTransmission">
            <summary>
            Gets or sets an integer that indicates the maximum number
            of points to be published to the historian at once.
            </summary>
        </member>
        <member name="P:HistorianAdapters.RemoteOutputAdapter.UseAsyncConnect">
            <summary>
            Gets flag that determines if this <see cref="T:HistorianAdapters.RemoteOutputAdapter"/> uses an asynchronous connection.
            </summary>
        </member>
        <member name="P:HistorianAdapters.RemoteOutputAdapter.Status">
            <summary>
            Returns the detailed status of the data output source.
            </summary>
        </member>
        <member name="T:HistorianAdapters.StatisticsReader">
            <summary>
            Reads certain device and input stream statistics from the statistics archive.
            The statistics that are read are the total frame count, the missing frame count,
            connectivity, average latency, the actual data rate, data quality errors, and
            time quality errors.
            </summary>
        </member>
        <member name="M:HistorianAdapters.StatisticsReader.#ctor">
            <summary>
            Creates a new instance of the <see cref="T:HistorianAdapters.StatisticsReader"/> class.
            All parameters--<see cref="P:HistorianAdapters.StatisticsReader.ArchiveFilePath"/>, <see cref="P:HistorianAdapters.StatisticsReader.StateFilePath"/>,
            <see cref="P:HistorianAdapters.StatisticsReader.IntercomFilePath"/>, <see cref="P:HistorianAdapters.StatisticsReader.MetadataFilePath"/>,
            <see cref="P:HistorianAdapters.StatisticsReader.StartTime"/>, and <see cref="P:HistorianAdapters.StatisticsReader.EndTime"/>--must be set manually
            before attempting to read statistics from the archive.
            </summary>
        </member>
        <member name="M:HistorianAdapters.StatisticsReader.#ctor(System.String)">
            <summary>
            Creates a new instance of the <see cref="T:HistorianAdapters.StatisticsReader"/> class.
            The configuration file specified in the parameter must contain the statistics
            historian records in order to automatically locate the archive files.
            Otherwise, the other constructor should be used. The <see cref="P:HistorianAdapters.StatisticsReader.StartTime"/> and
            <see cref="P:HistorianAdapters.StatisticsReader.EndTime"/> parameters are not set when using this constructor and must
            be set manually before attempting to read statistics from the archive.
            </summary>
            <param name="sourceConfigPath">Path to the source configuration file.</param>
        </member>
        <member name="M:HistorianAdapters.StatisticsReader.Open">
            <summary>
            Causes the <see cref="T:HistorianAdapters.StatisticsReader"/> to open the archive file and retrieve the statistics.
            </summary>
        </member>
        <member name="M:HistorianAdapters.StatisticsReader.Close">
            <summary>
            Closes the archive file once the statistics are no longer needed.
            </summary>
        </member>
        <member name="M:HistorianAdapters.StatisticsReader.Dispose">
            <summary>
            Releases all the resources used by the <see cref="T:HistorianAdapters.StatisticsReader"/> object.
            </summary>
        </member>
        <member name="P:HistorianAdapters.StatisticsReader.ArchiveFilePath">
            <summary>
            Path to the archive file (*_archive.d).
            </summary>
        </member>
        <member name="P:HistorianAdapters.StatisticsReader.StateFilePath">
            <summary>
            Path to the state file (*_startup.dat).
            </summary>
        </member>
        <member name="P:HistorianAdapters.StatisticsReader.IntercomFilePath">
            <summary>
            Path to the intercom file (scratch.dat).
            </summary>
        </member>
        <member name="P:HistorianAdapters.StatisticsReader.MetadataFilePath">
            <summary>
            Path to the metadata file (*_dbase.dat).
            </summary>
        </member>
        <member name="P:HistorianAdapters.StatisticsReader.StartTime">
            <summary>
            The timestamp at which to start gathering statistics from the archive.
            </summary>
        </member>
        <member name="P:HistorianAdapters.StatisticsReader.EndTime">
            <summary>
            The timestamp at which to stop gathering statistics from the archive.
            </summary>
        </member>
        <member name="P:HistorianAdapters.StatisticsReader.TotalFrames">
            <summary>
            After the <see cref="T:HistorianAdapters.StatisticsReader"/> has read statistics from the archive file,
            this will contain the statistics on the total number of frames.
            </summary>
        </member>
        <member name="P:HistorianAdapters.StatisticsReader.MissingFrames">
            <summary>
            After the <see cref="T:HistorianAdapters.StatisticsReader"/> has read statistics from the archive file,
            this will contain the statistics on missing frames.
            </summary>
        </member>
        <member name="P:HistorianAdapters.StatisticsReader.ConnectedStats">
            <summary>
            After the <see cref="T:HistorianAdapters.StatisticsReader"/> has read statistics from the archive file,
            this will contain the statistics on input stream connectivity.
            </summary>
        </member>
        <member name="P:HistorianAdapters.StatisticsReader.AverageLatency">
            <summary>
            After the <see cref="T:HistorianAdapters.StatisticsReader"/> has read statistics from the archive file,
            this will contain the statistics on the average latency.
            </summary>
        </member>
        <member name="P:HistorianAdapters.StatisticsReader.ActualDataRate">
            <summary>
            After the <see cref="T:HistorianAdapters.StatisticsReader"/> has read statistics from the archive file,
            this will contain the statistics on the actual data rate.
            </summary>
        </member>
        <member name="P:HistorianAdapters.StatisticsReader.DataQualityErrors">
            <summary>
            After the <see cref="T:HistorianAdapters.StatisticsReader"/> has read statistics from the archive file,
            this will contain the statistics on data quality errors.
            </summary>
        </member>
        <member name="P:HistorianAdapters.StatisticsReader.TimeQualityErrors">
            <summary>
            After the <see cref="T:HistorianAdapters.StatisticsReader"/> has read statistics from the archive file,
            this will contain the statistics on time quality errors.
            </summary>
        </member>
    </members>
</doc>
